doc: move describe/it aliases section before expectFailure#61567
doc: move describe/it aliases section before expectFailure#61567lraveri wants to merge 2 commits intonodejs:mainfrom
Conversation
|
Review requested:
|
nodejs-github-bot
added
doc
JakobJingleheimer
left a comment
JakobJingleheimer
left a comment
There was a problem hiding this comment.
I presume this is a cut-paste
yep, it is |
lraveri
force-pushed
the
doc/reorder-test-doc-sections
branch
from
48eeed9 to
4c1db7d
Compare
lraveri
changed the title
|
I think clarity would be better served by keeping all the flag options for IMHO one of the following:
|
|
Let's write a proposal for it (in the nodejs/test_runner repo) |
|
Ack, sorry. My request for a proposal was meant for a different
I think this is probably better (and move |
No worries. I think @vassudanagunta is right and we can change the example for expectFailure to use test instead of it and move the describe / it section where it was before. WDYT? @JakobJingleheimer |
|
I think either is fine, but regardless of I think it's slightly better to use |
Signed-off-by: Luca Raveri <lucaraveri993@gmail.com>
|
Ok, I moved the it / describe section up and grouped the flag sections together. Here the final structure: 
|
8 participants
The “Expecting tests to fail” section uses it() before the documentation explains that it() is an alias of test().
This reorders the relevant documentation sections so that the describe() / it() aliases are introduced before being used, improving readability for first-time readers.